=========================================================
Dedicated Server for Master Server Patch 2.4
=========================================================
September 27, 2018

CONTENTS
1. Setup
	1.1 Configuration
	1.2 Messages
	1.3 Admins
	1.4 Shared banlists
	1.5 Capture the Flag
	1.6 Domination

2. Usage
	2.1 Admin commands
	2.2 Public commands
	2.3 Voting commands
	2.4 Weapon and grenade ban parameters
	2.5 Server logs

3. History
	3.1 Version 2.4
	3.2 Version 2.3.3


=========================================================

1. Setup


	1.1 - Configuration
=========================================================

To start configuring the server, open serverconfig.txt. Here is a list of settings and their descriptions.

The settings under WeaponBan control which weapons players will be able to use in the game. The settings under GrenadeBan
will do so for various grenades and other projectiles.

UseVoting - Enables the vv system.
MapVoting - Enables map voting on the server. Only when the vv system is enabled.
ClassVoting - This allows switching class during Survivor and Hunt games. Only when the vv system is enabled.
DisallowNamechange - Disables the use of the <name> command.
AllWeapons - Enables all weapons mode.
FixCornerGlitching - Fixes corner glitching with aliens.
FixPulseStagger - Fixes pulse rifle stagger.
FixMinigunStagger - Fixes minigun stagger.
FixSniperStagger - Fixes sniper stagger.
F2FreeFly - Enables going into freefly from spawn protection with the F2 key.
DisableSmartgunTracking - Disables the smartgun tracking feature.
DisableAnticheat - Disables the anticheat functionality. Use this if you're running bute mods.



	1.2 - Messages
=========================================================

Automatic server messages can be configured in the messages.txt file. The server will read the first 25 messages from each section. 
The interval decides how often a message should be sent. The ratio decides which section will be addressed more often. 
If for instance you have 6 regular messages and 1 rule, you may want to set RatioBy to "Messages" and increase the ratio
to make sure the single rules entry won't be spammed over and over again. The file contains a sample setup.




	1.3 - Admins
=========================================================

This release contains a new admin system. Admins are now configured through the Admin Editor program shipped with this package.
Each admin will have their own set of permissions. To add a new admin, click the Add button. Enter the appropriate information
in the text fields. The ID field must contain the admin's hardware ID (can be obtained from the guidlog) to improve security.
Use the checkboxes to grant permissions to the newly created admin. Clicking Write to file will save your admin file.



	1.4 - Shared banlists
=========================================================

By default, the server will store four banlists in your game directory. You can also use the same list for all your servers
by adding the following directives in the serverconfig.txt file. You must specify an absolute path to a folder that already exists.

Example:

banfile = "c:\guidban.txt"
ipbanfile = "c:\ipban.txt"
hostbanfile = "c:\hostban.txt"
citybanfile = "c:\cityban.txt" (needs a city database)



	1.5 - Capture the Flag
=========================================================

This release contains the new Capture the Flag gametype. Example maps are contained in the ctfworlds folder in your
server directory. If you want to include more maps to your rotation, you must manually create new map files.
You can use the getposition admin command to retrieve your current position in game for the placement of the CTF objects.

Please note that you cannot configure this gametype inside the game. You must open the ServerData\unnamed.txt file
and edit the gametype manually.



	1.6 - Domination
=========================================================

This release contains the new Domination gametype. Example maps are contained in the domworlds folder in your
server directory. If you want to include more maps to your rotation, you must manually create new map files.
You can use the getposition admin command to retrieve your current position in game for the placement of the Domination objects.

Please note that you cannot configure this gametype inside the game. You must open the ServerData\unnamed.txt file
and edit the gametype manually.

=========================================================


2. Usage


	2.1 - Admin commands
=========================================================

Each command must be preceded by <serv> or /.

ban <id>
- Bans the specified player.

banhostmask <mask>
- Bans a host mask using wildcards. Use with caution.

banipmask <mask>
- Bans an ip mask using wildcards. Use with caution.

cityban <id>
- Bans the specified player's city. (needs a city database)

control <password>
- Takes control of the server.

classweapons
- Toggles the use of class weapon sets.

exosuit <number>
- Changes the number of exosuits on the map.

forceverify
- Skips the next level countdown.

friendlyfire
- Toggles friendly fire.

getposition
- Shows your current position. Useful for the placement of CTF and Domination objects.

grenadeban <grenade>
- Toggles availability of the specified grenade.

hostban <id>
- Bans the specified player's hostname.

ipban <id>
- Bans the specified player's IP address.

kick <id>
- Kicks the specified player.

kill <id>
- Kills the specified player.

lifecycle
- Toggles alien life cycle.

locationdamage
- Toggles location damage.

lockobserve <id>
- Locks the specified player in observe mode.

lockserver <password>
- Locks the server using the specified password.

maskloss
- Toggles predator mask loss.

mute <id>
- Mutes the specified player.

nextlevel
- Loads the next level.

observe <id>
- Puts the specified player in observe mode.

popupnames
- Toggles popup names.

prevlevel
- Loads the previous level.

queen <number>
- Changes the number of kills required to become a queen

releasecontrol
- Releases server control.

restart
- Restarts the current level.

showcity <id>
- Returns the specified player's city. (needs a city database)

showhostname <id>
- Returns the specified player's hostname.

showid <id>
- Returns the specified player's hardware ID.

showip <id>
- Returns the specified player's IP address

weaponban <weapon>
- Toggles availability of the specified weapon.



	2.2 - Public commands
=========================================================

The following commands can be used by everyone.

pcm <id> <message>
- Sends a private message to the specified player.

mver
- Returns the server version.

skins <id>
- Find out if a player is using skins.



	2.3 - Voting commands
=========================================================

The following commands are used for voting and changing class during Survivor and Hunt games.

vv<mapnumber>
- Vote for a map. Example: vv7 will vote for the 7th map in the list.

vvmaps
- Displays a list of maps in the rotation.

vv??
- Same as vvmaps

vvss
- Vote to skip the current map.

vv<character>
- Selects a different character. Example: vvdrone will change you into a Drone. Only works in Survivor and Hunt.



	2.4 - Weapon and grenade ban parameters
=========================================================

The following weapons can be passed to the weaponban command.

shotgun - Disables the shotgun.
pulse - Disables the pulse rifle.
grenade - Disables the grenade launcher.
flame - Disables the flamethrower.
smart - Disables the smartgun.
bazooka - Disables the bazooka.
mini - Disables the minigun.
sniper - Disables the sniper rifle.
predpistol - Disables the plasma pistol.
spear - Disables the speargun.
cannon - Disables the plasma cannon.
net - Disables the netgun.
bomb - Disables sticky bombs.

The following grenades can be passed to the grenadeban command.

pulse - Disables pulse rifle grenades.
timed - Disables timed grenades (grenade launcher).
proxy - Disables proximity grenades (grenade launcher).
emp - Disables emp grenades (grenade launcher).
spider - Disables spider grenades (grenade launcher).
trackingrockets - Disables tracking rockets (bazooka).
flare - Disables flares.



	2.5 - Server logs
=========================================================

The server keeps a set of log files to make your life easier. The following log files are created.

chatlog.txt - Contains all chat messages on the server.
guidlog.txt - Contains GUIDs of connected players.
iplog.txt - Contains IPs of connected players.
hostlog.txt - Contains hostnames of connected players.
citylog.txt - Contains city names of connected players. (needs a city database)
adminlog.txt - Contains all commands issued by admins.
namechangelog.txt - Contains all name changes.
anticheatlog.txt - Contains cheat detections.


	3.1 - Version 2.4
=========================================================

 - Moved the master server to a more stable provider.


	3.2 - Version 2.3.3
=========================================================

 - Fixed a bug that prevented players from entering observe mode in team games.
 - Fixed many crashes.
 - Fixed a small issue with the packet buffer.
 - Server owners can now toggle Alien life regeneration.
 - Server owners can now change the minimum opacity for cloaked Predators.
 - Fixed a memory overflow caused by some custom maps.
 - Survivor games will now run round reset scripts.
 - Fixed an infinite loop caused by some custom maps.
 - Fixed a few issues with the new client validation protocol.
 - The server will now reject connections during initialization.
 - Removed the restart feature due to numerous problems with it.
 - Added support for multiple gametypes and an infinite number of maps.